GET api/channel/{authenticationToken}/{loanKey}

This method will return the business channel data associated with a specific loan.

Request Information

URI Parameters

Name	Description	Type	Additional information
authenticationToken	Current authentication token	string	Required
loanKey	The loan key string identifying the loan whose business channel data is to be returned.	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns a Channel Model object with information about the desired business channel.

ChannelModel

Name	Description	Type	Additional information
ChannelKey	This is the identifier for the business channel.	string	None.
Alias	This is the business channel alias.	string	None.
Description	This is the description for the business channel.	string	None.
IsEmployeeChannel	Is this business channel for employees only?	boolean	None.
IsActive	Is this business channel currently active?	boolean	None.
IsRetail	Is this a retail mortgage business channel?	boolean	None.
IsWholesale	Is this a wholesale mortgage business channel?	boolean	None.
IsCommercial	Is this a commercial loan business channel?	boolean	None.
IsConsumer	Is this a consumer loan business channel?	boolean	None.
IsCorrespondent	Is this a correspondent business channel?	boolean	None.
IsRealEstate	Is this business channel being used for a real estate transaction?	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ChannelKey": "sample string 1",
  "Alias": "sample string 2",
  "Description": "sample string 3",
  "IsEmployeeChannel": true,
  "IsActive": true,
  "IsRetail": true,
  "IsWholesale": true,
  "IsCommercial": true,
  "IsConsumer": true,
  "IsCorrespondent": true,
  "IsRealEstate": true
}

application/xml, text/xml

Sample:

<ChannelModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <Alias>sample string 2</Alias>
  <ChannelKey>sample string 1</ChannelKey>
  <Description>sample string 3</Description>
  <IsActive>true</IsActive>
  <IsCommercial>true</IsCommercial>
  <IsConsumer>true</IsConsumer>
  <IsCorrespondent>true</IsCorrespondent>
  <IsEmployeeChannel>true</IsEmployeeChannel>
  <IsRealEstate>true</IsRealEstate>
  <IsRetail>true</IsRetail>
  <IsWholesale>true</IsWholesale>
</ChannelModel>